import { Param } from "./types";

export const PydocstyleParamList: Param[] = [
    {
        name: "convention",
        descEn: "Whether to use Google-style or NumPy-style conventions or the PEP257 defaults when analyzing docstring sections.",
        descCn: "",
        defaultValue: null,
        optionList: [null, "google", "numpy", "pep257"],
        url: "https://beta.ruff.rs/docs/settings/#convention",
    },
    {
        name: "ignore-decorators",
        descEn: "Ignore docstrings for functions or methods decorated with the specified fully-qualified decorators.",
        descCn: "",
        defaultValue: [],
        url: "https://beta.ruff.rs/docs/settings/#ignore-decorators",
    },
    {
        name: "property-decorators",
        descEn: `A list of decorators that, when applied to a method, indicate that the method should be treated as a property (in addition to the builtin @property and standard-library @functools.cached_property).`,
        descCn: "",
        defaultValue: [],
        url: "https://beta.ruff.rs/docs/settings/#property-decorators",
    },
];